Platform Explorer / Nuxeo Platform 2023.12

Operation NuxeoDrive.UpdateFile (Nuxeo Drive: Update file)

Description

Update the document backing the file system item with the given id with the input blob. Return the file system item backed by the updated document as a JSON blob.
Operation id NuxeoDrive.UpdateFile
Category Services
Label Nuxeo Drive: Update file
Requires
Since

Parameters

Name Description Type Required Default value
id Id of the file system item backed by the document to update. string yes  
parentId Optional id of the file system item backed by the parent container of the document to update. For optimization purpose. string no  

Signature

Inputs blob
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.drive.operations.NuxeoDriveUpdateFile
Contributing Component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON Definition

{
  "id" : "NuxeoDrive.UpdateFile",
  "label" : "Nuxeo Drive: Update file",
  "category" : "Services",
  "requires" : null,
  "description" : "Update the document backing the file system item with the given id with the input blob. Return the file system item backed by the updated document as a JSON blob.",
  "url" : "NuxeoDrive.UpdateFile",
  "signature" : [ "blob", "blob" ],
  "params" : [ {
    "name" : "id",
    "description" : "Id of the file system item backed by the document to update.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "parentId",
    "description" : "Optional id of the file system item backed by the parent container of the document to update. For optimization purpose.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}